<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: /bb/mbigc/mbig5696/git/quantum_external/src/interface/quantum_ithread_promise.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('df/df0/quantum__ithread__promise_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">quantum_ithread_promise.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">** Copyright 2018 Bloomberg Finance L.P.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">** Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">** you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">** You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">**     http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">** Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">** distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">** See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">** limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef BLOOMBERG_QUANTUM_ITHREAD_PROMISE_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define BLOOMBERG_QUANTUM_ITHREAD_PROMISE_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;quantum/interface/quantum_icontext_base.h&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;quantum/interface/quantum_ipromise_base.h&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;quantum/interface/quantum_ifuture.h&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a> {</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">namespace </span>quantum {</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">//                                interface IThreadPromise</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">template</span>&lt;<span class="keyword">class</span>&gt; <span class="keyword">class </span>PROMISE, <span class="keyword">class </span>T&gt;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html">   34</a></span>&#160;<span class="keyword">struct </span><a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html">IThreadPromise</a> : <span class="keyword">public</span> <a class="code" href="../../db/db8/structBloomberg_1_1quantum_1_1Traits_1_1DerivedFrom.html">Traits::DerivedFrom</a>&lt;PROMISE&lt;T&gt;,</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;                                                   IThreadPromise&lt;PROMISE, T&gt;,</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;                                                   IPromiseBase&gt;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a1ce02dae237c894712bbcf5944ce667f">   38</a></span>&#160;    <span class="keyword">using</span> <a class="code" href="../../de/de9/structBloomberg_1_1quantum_1_1ThreadContextTag.html">ContextTag</a> = <a class="code" href="../../de/de9/structBloomberg_1_1quantum_1_1ThreadContextTag.html">ThreadContextTag</a>;</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#af1e82db2454481d25c450d3abfb6b92a">   39</a></span>&#160;    <span class="keyword">using</span> <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#af1e82db2454481d25c450d3abfb6b92a">Ptr</a> = std::shared_ptr&lt;IThreadPromise&lt;PROMISE, T&gt;&gt;;</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#ab90097118fc584e6cf48ebe6a4dc790a">   40</a></span>&#160;    <span class="keyword">using</span> <a class="code" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html">Impl</a> = PROMISE&lt;T&gt;;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a0b9f36ef976ba85a4c295dc529ac6514">   45</a></span>&#160;    <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a0b9f36ef976ba85a4c295dc529ac6514">IThreadPromise</a>(<a class="code" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html">Impl</a>* derived){ UNUSED(derived); }</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    </div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a742e0d39218b80ae60f30d47ae58bbc9">ThreadFuturePtr&lt;T&gt;</a> <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a55aba3f73fdac67237ff2e65e51e6dcb">getIThreadFuture</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    </div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">class</span> V, <span class="keyword">class</span> = NonBufferType&lt;T,V&gt;&gt;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#aa20cb305dbdeea0569fd66acae135cd2">set</a>(V&amp;&amp; value);</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    </div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">class</span> V, <span class="keyword">class</span> = BufferType&lt;T,V&gt;&gt;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a1daff44dbd6d5daf7a576dd4fdb55884">push</a>(V&amp;&amp; value);</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    </div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">class</span> V = T, <span class="keyword">class</span> = BufferRetType&lt;V&gt;&gt;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a4f8c0ac8bc69a7e6265a3d2d24a9d00b">closeBuffer</a>();</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;};</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Promise;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#ade87d49e44470f3d0633488c46902d80">   79</a></span>&#160;<span class="keyword">using</span> <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html">ThreadPromise</a> = <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html">IThreadPromise&lt;Promise,T&gt;</a>;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a29fb505e41c528b77405836d345259c6">   82</a></span>&#160;<span class="keyword">using</span> <a class="code" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a29fb505e41c528b77405836d345259c6">ThreadPromisePtr</a> = <span class="keyword">typename</span> <a class="code" href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html">IThreadPromise&lt;Promise,T&gt;::Ptr</a>;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;}}</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="preprocessor">#endif //BLOOMBERG_QUANTUM_ITHREAD_PROMISE_H</span></div><div class="ttc" id="namespaceBloomberg_1_1quantum_html_a29fb505e41c528b77405836d345259c6"><div class="ttname"><a href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a29fb505e41c528b77405836d345259c6">Bloomberg::quantum::ThreadPromisePtr</a></div><div class="ttdeci">typename IThreadPromise&lt; Promise, T &gt;::Ptr ThreadPromisePtr</div><div class="ttdef"><b>Definition:</b> quantum_ithread_promise.h:82</div></div>
<div class="ttc" id="namespaceBloomberg_html"><div class="ttname"><a href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:22</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadPromise_html_a4f8c0ac8bc69a7e6265a3d2d24a9d00b"><div class="ttname"><a href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a4f8c0ac8bc69a7e6265a3d2d24a9d00b">Bloomberg::quantum::IThreadPromise::closeBuffer</a></div><div class="ttdeci">int closeBuffer()</div><div class="ttdoc">Close a promise buffer.</div><div class="ttdef"><b>Definition:</b> quantum_promise_impl.h:45</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1Traits_1_1DerivedFrom_html"><div class="ttname"><a href="../../db/db8/structBloomberg_1_1quantum_1_1Traits_1_1DerivedFrom.html">Bloomberg::quantum::Traits::DerivedFrom</a></div><div class="ttdef"><b>Definition:</b> quantum_traits.h:78</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadPromise_html_a1daff44dbd6d5daf7a576dd4fdb55884"><div class="ttname"><a href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a1daff44dbd6d5daf7a576dd4fdb55884">Bloomberg::quantum::IThreadPromise::push</a></div><div class="ttdeci">void push(V &amp;&amp;value)</div><div class="ttdoc">Push a single value into the promise buffer.</div><div class="ttdef"><b>Definition:</b> quantum_promise_impl.h:38</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Promise_html"><div class="ttname"><a href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html">Bloomberg::quantum::Promise</a></div><div class="ttdoc">Class representing a promised value.</div><div class="ttdef"><b>Definition:</b> quantum_icoro_promise.h:77</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadPromise_html_a0b9f36ef976ba85a4c295dc529ac6514"><div class="ttname"><a href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a0b9f36ef976ba85a4c295dc529ac6514">Bloomberg::quantum::IThreadPromise::IThreadPromise</a></div><div class="ttdeci">IThreadPromise(Impl *derived)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> quantum_ithread_promise.h:45</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadPromise_html"><div class="ttname"><a href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html">Bloomberg::quantum::IThreadPromise</a></div><div class="ttdoc">Exposes methods to access and manipulate a non-coroutine promise (i.e. used in a thread)</div><div class="ttdef"><b>Definition:</b> quantum_ithread_promise.h:34</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1ThreadContextTag_html"><div class="ttname"><a href="../../de/de9/structBloomberg_1_1quantum_1_1ThreadContextTag.html">Bloomberg::quantum::ThreadContextTag</a></div><div class="ttdef"><b>Definition:</b> quantum_icontext_base.h:26</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadPromise_html_af1e82db2454481d25c450d3abfb6b92a"><div class="ttname"><a href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#af1e82db2454481d25c450d3abfb6b92a">Bloomberg::quantum::IThreadPromise&lt; Promise, T &gt;::Ptr</a></div><div class="ttdeci">std::shared_ptr&lt; IThreadPromise&lt; Promise, T &gt; &gt; Ptr</div><div class="ttdef"><b>Definition:</b> quantum_ithread_promise.h:39</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadPromise_html_a55aba3f73fdac67237ff2e65e51e6dcb"><div class="ttname"><a href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#a55aba3f73fdac67237ff2e65e51e6dcb">Bloomberg::quantum::IThreadPromise::getIThreadFuture</a></div><div class="ttdeci">virtual ThreadFuturePtr&lt; T &gt; getIThreadFuture() const =0</div><div class="ttdoc">Get the associated thread future.</div></div>
<div class="ttc" id="namespaceBloomberg_1_1quantum_html_a742e0d39218b80ae60f30d47ae58bbc9"><div class="ttname"><a href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a742e0d39218b80ae60f30d47ae58bbc9">Bloomberg::quantum::ThreadFuturePtr</a></div><div class="ttdeci">typename IThreadFuture&lt; T &gt;::Ptr ThreadFuturePtr</div><div class="ttdef"><b>Definition:</b> quantum_ithread_future.h:69</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1IThreadPromise_html_aa20cb305dbdeea0569fd66acae135cd2"><div class="ttname"><a href="../../da/deb/structBloomberg_1_1quantum_1_1IThreadPromise.html#aa20cb305dbdeea0569fd66acae135cd2">Bloomberg::quantum::IThreadPromise::set</a></div><div class="ttdeci">int set(V &amp;&amp;value)</div><div class="ttdoc">Set the promised value.</div><div class="ttdef"><b>Definition:</b> quantum_promise_impl.h:31</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_650ee533936399e683a30afb9473a469.html">interface</a></li><li class="navelem"><b>quantum_ithread_promise.h</b></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
